home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d1 / list569c.arc / LIST569C.DOC < prev    next >
Text File  |  1987-01-24  |  13KB  |  368 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                LIST  Version 5.69c
  7.         (c) Copyright Vernon D. Buerg 1987
  8.                All rights reserved
  9.  
  10.  
  11.  
  12.  
  13.             Table of Contents
  14.             -----------------
  15.  
  16.         Description ....................... 1
  17.         Keys and commands ................. 2
  18.         Cloning procedure ................. 4
  19.         DEBUG Information ................. 4
  20.         Screen attributes ................. 5
  21.         Scanning for text ................. 6
  22.         Update history .................... 7
  23.         Restrictions ...................... 8
  24.  
  25.  
  26.                              LIST      Page 1
  27.  
  28.  Command  LIST
  29.  -------------
  30.  
  31.  Purpose:  To display the contents of an ASCII text file,  line by  line
  32.        with the aid of scrolling and positioning commands.
  33.  
  34.  Format:   LIST  [d:][path]filename[.ext]
  35.  
  36.  Remarks:  An ASCII file of any size may be listed.
  37.  
  38.        The "filename" is optional.  If omitted, you are prompted  to
  39.     to enter  a filename.    You may  include drive,  path, and  wild
  40.     cards in the file name.   The first file which matches    the name
  41.     is displayed until an end-of-file character is encountered. Each
  42.     file which matches the "filename" may be displayed.
  43.  
  44.        LIST was  designed to  display ASCII  files.  That  is, files
  45.     which  contain    text  and  not    binary    or  control codes.  Text
  46.     characters usually range from a value of 32 to 127.
  47.  
  48.        Characters  below  32  (a  blank)  are  replaced with a funny
  49.     character to indicate that a non-displayable character has  been
  50.     encountered.  This character is an upside-down question mark.
  51.  
  52.        Characters above 127 may be valid graphic characters, and may
  53.     be displayed if  the '8' command  is in effect.   To insure that
  54.     characters above ASCII value 127 are not displayed, use the  '7'
  55.     command.
  56.  
  57.        The top line of the display gives the file name, current right
  58.     scroll offset, and the file's creation date and time. Optionally,
  59.     a ruler may be displayed on the top line by using the alt-R keys.
  60.  
  61.        The    file  is  displayed  with  one    logical  record  on each
  62.     80-column display line.   A logical record  ends in a  linefeed.
  63.     The maximum logical record may    be 255 characters long.  If  the
  64.     record exceeds 80  characters, you may    view the portion  beyond
  65.     the 80 columns    by using the  scroll right command,  or by using
  66.     the Wrap feature.
  67.  
  68.        The Wrap  command toggles  ON or  OFF the  wrapping of  lines
  69.     longer than 80 characters.  With Wrap on, lines are displayed in
  70.     their  entirety,  80  characters  per  display line.  The scroll
  71.     -left and -right functions are disabled when Wrap is ON.
  72.  
  73.        The file may  be PRINTed as    it it displayed.   The P command
  74.     toggles  the  printer  on  or  off.   When  first entered, the P
  75.     command causes the current screen  to be printed.  As new  lines
  76.     are displayed, they too are printed.  Printing may be stopped by
  77.     entering another P command.  The PrtSc key may also be used, but
  78.     the title and prompt lines will be printed with the lines of the
  79.     file. Empty lines cause a line to be skipped on the printer. The
  80.     letter P is displayed in column 80 of the top line while printing.
  81.  
  82.                              LIST      Page 2
  83.  Key functions and Commands
  84.  --------------------------
  85.  
  86.     On the COMMAND line, enter a letter or control key:
  87.  
  88.     Letter(s)     Default    Function
  89.     ---------     -------    ------------------------
  90.     A            find next occurance of 'text'
  91.     B            skip to end of file (bottom)
  92.     C        off    toggles closing of (shared) files
  93.     D or +            scroll down one page
  94.     F            Find 'text' regardless of case
  95.     H or ?            list commands (HELP)
  96.     K        off    toggle keyboard flush
  97.     L            scroll left 20 columns
  98.     M        on    toggle test for display retrace
  99.     N            down one (next) line
  100.     P        off    toggle printer on or off
  101.     Q            display next matching file
  102.     R            scroll right 20 columns
  103.     S            Scan for exact text match
  104.     T            restart from first block (top)
  105.     U or -            scroll up one page
  106.     W        off    toggle wrap of lines over 80 chars
  107.     X            terminate, clear screen and exit to DOS
  108.     7        off    turn off high bit (non-graphics only)
  109.     8        on    leave high bit on (graphics)
  110.  
  111.     \text            Find 'text' regardless of case
  112.     /text            Scan for exact text match
  113.  
  114.  
  115.     Control key      Function
  116.     -----------     -------------------------------------------
  117.      Enter         continue to next page
  118.      END         position to end of block
  119.      ESCape         Display next matching file
  120.      HOME         restart from first block (top)
  121.      PgUp         scroll up one page
  122.      PgDn         scroll down one page
  123.  
  124.      left arrow      scroll left 20 columns
  125.      right arrow     scroll right 20 columns
  126.      up arrow         up one (previous) line
  127.      down arrow      down one (next) line
  128.  
  129.      ctl-HOME         restart from CURRENT (64k) block
  130.      ctl-PgUp         restart from first block (TOP)
  131.      ctl-PgDn         skip to end of file (BOTTOM)
  132.      ctl-left-arrow  reset scroll to column 1
  133.  
  134.      F1          Help - display summary of commands
  135.      F3          Find next occurrance of text after Scan or Find
  136.      F10         Exit to DOS
  137.  
  138.      F5          change background color for main body of display
  139.      F6          change foreground color for main body of display
  140.      F7          change background color for top and bottom lines
  141.      F8          change foreground color for top and bottom lines
  142.                              LIST      Page 4
  143.  
  144.  Key functions and Commands (cont.)
  145.  --------------------------
  146.  
  147.  
  148.     Control key      Function
  149.     -----------     -------------------------------------------
  150.      alt-C         clone LIST.COM, change colors permanently in program file
  151.      alt-R         toggles display of a ruler on the top line
  152.  
  153.  
  154.  
  155.  Cloning procedure
  156.  -----------------
  157.  
  158.        The screen colors, the display retrace testing (M), the file
  159.     closing (C) and ruler (alt-R) options may be permanently set in
  160.     the program by using the alt-C cloning function.
  161.  
  162.        For cloning to take effect, the program must be called
  163.     LIST.COM and it must be on the current drive and in the current
  164.     directory.
  165.  
  166.  
  167.  DEBUG Information
  168.  -----------------
  169.  
  170.        An alternative to cloning is to use DEBUG to make permanent
  171.     changes. Here is a list of key items and their addresses:
  172.  
  173. |       0128 - special lines 1 and 25 colors, default is 01
  174.           Refer to a technical reference guide for the
  175.           attribute values for the colors that you want.
  176. |       012A - normal lines 2 thru 24 colors, default is 02
  177. |       012C - bright color for Find/Scan, default is 04
  178. |       012E - options; bits 6, 7 and 8
  179.            .... .SAR  S=shared, x'04'
  180.                   A=ruler, x'02
  181.                   R=retrace, x'01'
  182.           By specifying the bit value, the option is enabled.
  183.           For example, to enable Shared and Retrace, specify
  184.           a hex value of 05.
  185.  
  186.        The letters and command keys may also be changed.  There are
  187.     two tables involved:  WHAT and WHERE.  The WHAT table contains a
  188.     list of one-byte keyboard codes.  The WHERE table contains a
  189.     list of two-byte addresses.  If you really want to change the
  190.     codes, here are the DEBUG addresses:
  191.  
  192. |       0353 - *WHAT* eye catcher
  193. |       0359 - list of one byte command letters and codes
  194.  
  195. |       038B - *WHERE* eye catcher
  196. |       0392 - list of two byte addresses of processing routines
  197.  
  198.  
  199.     NOTE: These DEBUG addresses are version dependent.
  200.  
  201.                              LIST      Page 5
  202.  
  203.  Screen attributes
  204.  -----------------
  205.  
  206.        The colors used for displaying the titles and main body of
  207.     text may be changed temporarily or permanently.  To make a
  208.     permanent change, the cloning command alt-C is used.  It
  209.     requires that the LIST.COM program file be on the current drive
  210.     and in the current directory.
  211.  
  212.        There are three classes of attributes used.    One for normal
  213.     display lines - lines 2 to 24 - another for special lines -
  214.     lines 1 and 25, and a third for the Find/Scan color.  The border
  215.     is not changed.  The foreground color applies to the characters
  216.     displayed.
  217.  
  218.     These color attributes may be changed by using these function keys:
  219.  
  220.       For the main body of text:
  221.  
  222.         F5 - background color
  223.         F6 - foreground color
  224.  
  225.       For the top and bottom lines:
  226.  
  227.         F7 - background color
  228.         F8 - foreground color
  229.  
  230.  
  231.     Once you have decided upon the colors, use the alt-C key
  232.     combination to change the LIST.COM program file.
  233.  
  234.                              LIST      Page 6
  235.  
  236.  Scanning for text
  237.  -----------------
  238.  
  239.  
  240.        You may use    Find (\)  to search for text  regardless  of the
  241.     case, or you may use Scan (/) to find an exact match.
  242.  
  243.        To scan for a character string, type a slash (/) followed  by
  244.     one or more (up to 31)    characters.  The scan text, but not  the
  245.     slash,    is  displayed  on  the    command  line.    The scan is case
  246.     sensitive.  That is, lower case scan text will only match  lower
  247.     lower case file text.
  248.  
  249.        While  the  program    is  searching  for  the text, the bottom
  250.     display line is changed to say "Scanning".
  251.  
  252.        If the text is found, the line containing it is displayed  as
  253.     a high-intensity line (bright color).
  254.  
  255.        If the text is NOT found, the bottom line (25) is changed  to
  256.     say '*** text not found ***', and the display remains unchanged.
  257.     If the file exceeds 64k, it may be necessary to re-enter the
  258.     scan text each 64k byte segment. This is a known problem that
  259.     will be corrected in a future version.
  260.  
  261.        To find the next occurrance of the same text,  use the A)gain
  262.     command, or press the F3 key.
  263.  
  264.        In a shared file environment, if the file changes while being
  265.     listed, the file position may become invalid. Use the HOME command
  266.     to insure proper file synchronization, or use the C (shared) option.
  267.  
  268.                              LIST      Page 7
  269.  
  270. Update history
  271. --------------
  272.  
  273.     Lines beginning with | denote changes to the latest version.
  274.  
  275.     Version 4.1, April 27, 1984.
  276.     Version 4.15, June 2, 1984.
  277.     Version 4.2, July 14, 1984.
  278.     Version 5.0, August 10, 1984.
  279.     Version 5.1, August 27, 1984.
  280.     Version 5.2, September 29, 1984.
  281.     Version 5.4, March 22, 1984.
  282.     Version 5.48, May 27, 1985.
  283.     Version 5.49, May 31, 1985.
  284.     Version 5.52, July 15, 1985.
  285.  
  286.     Version 5.56, December 20, 1985.
  287.         Adds alt-R to toggle a ruler on the top line.
  288.         Make LIST compatible with DESQview.
  289.  
  290.     Version 5.64, January 6, 1986.
  291.         Add suport for 40 (and other?) column displays
  292.         Add M command to toggle test for display retrace
  293.         Include LISTxxxS.COM without HELP as a smaller, <4k version
  294.  
  295.     Version 5.65, January 16, 1986.
  296.         Corrections for consecutive line feeds without CRs
  297.         Corrections for Down at end of file
  298.  
  299.     Version 5.67, February 11, 1986.
  300.         Special CRT request version, not released for general use.
  301.         Change X to clear screen and leave cursor at top of screen.
  302.         Close files to allow shared use.
  303.  
  304.     Version 5.68, February 27, 1986.
  305.         Add C command to toggle closing of files for shared systems.
  306.         Make (M) retrace, (C) shared and the ruler clonable options.
  307.         Modify checks for DESQ because of APX Core incompatibilities.
  308.         Display a P in line 1, column 80, while printing.
  309.  
  310.     Version 5.69, April 14, 1986 (not released).
  311.         Correct detection of mono display for setting of (M) option
  312.  
  313.     Version 5.69b, Sept 2, 1986.
  314.         Eliminate flicker at TOF/ EOF using PgUp/PgDn and up/down
  315.  
  316. |    Version 5.69c, Jan 20, 1987
  317. |        Added DOS 3.x file sharing.
  318.  
  319.  
  320.         This is the last version of LIST. All subsequent versions
  321.         represent a rewritten program called LIST/SOL.
  322.  
  323.                              LIST      Page 8
  324.  
  325.  Restrictions
  326.  ------------
  327.  
  328.        Some positioning is relative to the current block in storage.
  329.     The size of the block depends on the amount of memory available,
  330.     and up to 64K-bytes is allocated to the file buffer. The program
  331.     requires at least 6K bytes.
  332.  
  333.     o  PC-DOS Version 2.0 or later is required.
  334.  
  335.     o  ANSI.SYS is NOT required.
  336.  
  337.  
  338.     Written by Vernon Buerg for the  IBM PC using DOS 2.0 or
  339.     later, including DOS 3.2.
  340.  
  341.     LIST is supplied for personal, private use. Feel free to
  342.     distribute LIST given these restrictions:
  343.  
  344.       o  the program shall be supplied in its original,
  345.          unmodified form, which includes this documentation;
  346.  
  347.       o  no fee is charged.
  348.  
  349.       o  commmercial use is prohibited.
  350.  
  351.       o  the program may not be included - or bundled - with
  352.          other goods or services. Exceptions may be granted
  353.          upon written request only.
  354.  
  355.     If you are using LIST and find it of value, your gift in
  356.     any amount ($15 suggested) will be greatly appreciated.
  357.     Makes checks payable to Vernon D. Buerg.
  358.  
  359.     For use by corporations and other institutions, please
  360.     contact AAI Systems for a site licensing agreement.
  361.  
  362.         Vernon D. Buerg
  363.         456 Lakeshire Drive
  364.         Daly City, CA 94015
  365.         Data: (415) 994-2944 (BBS)
  366.         Compuserve: 70007,1212
  367.  
  368.